

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>pysiriproxy.constants &mdash; pysiriproxy v0.0.7 documentation</title>
    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../',
        VERSION:     '0.0.7',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../../_static/jquery.js"></script>
    <script type="text/javascript" src="../../_static/underscore.js"></script>
    <script type="text/javascript" src="../../_static/doctools.js"></script>
    <link rel="top" title="pysiriproxy v0.0.7 documentation" href="../../index.html" />
    <link rel="up" title="Module code" href="../index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../index.html">pysiriproxy v0.0.7 documentation</a> &raquo;</li>
          <li><a href="../index.html" accesskey="U">Module code</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <h1>Source code for pysiriproxy.constants</h1><div class="highlight"><pre>
<span class="c"># Copyright (C) 2012 Brett Ponsler, Pete Lamonica</span>
<span class="c"># See the file &quot;COPYING&quot; for the full license governing this code.</span>
<span class="c">#</span>
<span class="c"># pysiriproxy is free software: you can redistribute it and/or modify</span>
<span class="c"># it under the terms of the GNU General Public License as published by</span>
<span class="c"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c"># (at your option) any later version.</span>
<span class="c">#</span>
<span class="c"># pysiriproxy is distributed in the hope that it will be useful,</span>
<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<span class="c"># GNU General Public License for more details.</span>
<span class="c">#</span>
<span class="c"># You should have received a copy of the GNU General Public License</span>
<span class="c"># along with pysiriproxy.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<span class="sd">&#39;&#39;&#39;The constants module contains classes which contain properties that</span>
<span class="sd">define various constant values used throughout the system.</span>

<span class="sd">The majority of these properties are used to access certain values from the</span>
<span class="sd">object dictionaries sent between the iPhone and Apple&#39;s server.</span>

<span class="sd">&#39;&#39;&#39;</span>
<span class="kn">from</span> <span class="nn">pyamp.patterns</span> <span class="kn">import</span> <span class="n">Enum</span>


<div class="viewcode-block" id="Modes"><a class="viewcode-back" href="../../_generated/pysiriproxy_constants.html#pysiriproxy.constants.Modes">[docs]</a><span class="k">class</span> <span class="nc">Modes</span><span class="p">:</span>
    <span class="sd">&#39;&#39;&#39;The Modes class contains properties which define different types of</span>
<span class="sd">    data receiving modes.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">Line</span> <span class="o">=</span> <span class="s">&quot;line&quot;</span>
    <span class="sd">&#39;&#39;&#39;The Line property indicates the mode in which lines of data is</span>
<span class="sd">    sent and received.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">Raw</span> <span class="o">=</span> <span class="s">&quot;raw&quot;</span>
    <span class="sd">&#39;&#39;&#39;The Raw property indicates the mode in which raw data is sent</span>
<span class="sd">    and received.</span>

<span class="sd">    &#39;&#39;&#39;</span>

</div>
<div class="viewcode-block" id="Directions"><a class="viewcode-back" href="../../_generated/pysiriproxy_constants.html#pysiriproxy.constants.Directions">[docs]</a><span class="k">class</span> <span class="nc">Directions</span><span class="p">:</span>
    <span class="sd">&#39;&#39;&#39;The Directions class contains several properties which are used to</span>
<span class="sd">    indicate which direction data is entering the system.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">From_Server</span> <span class="o">=</span> <span class="s">&quot;From_Server&quot;</span>
    <span class="sd">&#39;&#39;&#39;The From_Server property indicates that data was received from Apple&#39;s</span>
<span class="sd">    server.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">From_iPhone</span> <span class="o">=</span> <span class="s">&quot;From_iPhone&quot;</span>
    <span class="sd">&#39;&#39;&#39;The From_iPhone property indicates that data was received from the</span>
<span class="sd">    iPhone.</span>

<span class="sd">    &#39;&#39;&#39;</span>

</div>
<div class="viewcode-block" id="ClassNames"><a class="viewcode-back" href="../../_generated/pysiriproxy_constants.html#pysiriproxy.constants.ClassNames">[docs]</a><span class="k">class</span> <span class="nc">ClassNames</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
    <span class="sd">&#39;&#39;&#39;The ClassNames class contains properties which define the names of the</span>
<span class="sd">    class names of objects sent between the iPhone and Apple&#39;s server.</span>

<span class="sd">    &#39;&#39;&#39;</span>
    <span class="n">AnyObject</span> <span class="o">=</span> <span class="s">&quot;AnyObject&quot;</span>
    <span class="sd">&#39;&#39;&#39;The AnyObject property defined the AnyObject object class.&#39;&#39;&#39;</span>

    <span class="n">CancelRequest</span> <span class="o">=</span> <span class="s">&quot;CancelRequest&quot;</span>
    <span class="sd">&#39;&#39;&#39;The CancelRequest property defined the CancelRequest object class.&#39;&#39;&#39;</span>

    <span class="n">CancelSpeech</span> <span class="o">=</span> <span class="s">&quot;CancelSpeech&quot;</span>
    <span class="sd">&#39;&#39;&#39;The CancelSpeech property defined the CancelSpeech object class.&#39;&#39;&#39;</span>

    <span class="n">ClearContext</span> <span class="o">=</span> <span class="s">&quot;ClearContext&quot;</span>
    <span class="sd">&#39;&#39;&#39;The ClearContext property defined the ClearContext object class.&#39;&#39;&#39;</span>

    <span class="n">CommandIgnored</span> <span class="o">=</span> <span class="s">&quot;CommandIgnored&quot;</span>
    <span class="sd">&#39;&#39;&#39;The CommandIgnored property defined the CommandIgnored object class.&#39;&#39;&#39;</span>

    <span class="n">CommandFailed</span> <span class="o">=</span> <span class="s">&quot;CommandFailed&quot;</span>
    <span class="sd">&#39;&#39;&#39;The CommandFailed property defined the CommandFailed object class.&#39;&#39;&#39;</span>

    <span class="n">FinishSpeech</span> <span class="o">=</span> <span class="s">&quot;FinishSpeech&quot;</span>
    <span class="sd">&#39;&#39;&#39;The FinishSpeech property defined the FinishSpeech object class.&#39;&#39;&#39;</span>

    <span class="n">LoadAssistant</span> <span class="o">=</span> <span class="s">&quot;LoadAssistant&quot;</span>
    <span class="sd">&#39;&#39;&#39;The LoadAssistant property defined the LoadAssistant object class.&#39;&#39;&#39;</span>

    <span class="n">RequestCompleted</span> <span class="o">=</span> <span class="s">&quot;RequestCompleted&quot;</span>
    <span class="sd">&#39;&#39;&#39;The RequestCompleted property defined the RequestCompleted object</span>
<span class="sd">    class.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">SetApplicationContext</span> <span class="o">=</span> <span class="s">&quot;SetApplicationContext&quot;</span>
    <span class="sd">&#39;&#39;&#39;The SetApplicationContext property defined the SetApplicationContext</span>
<span class="sd">    object class.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">SetRequestOrigin</span> <span class="o">=</span> <span class="s">&quot;SetRequestOrigin&quot;</span>
    <span class="sd">&#39;&#39;&#39;The SetRequestOrigin property defined the SetRequestOrigin object</span>
<span class="sd">    class.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">SetRestrictions</span> <span class="o">=</span> <span class="s">&quot;SetRestrictions&quot;</span>
    <span class="sd">&#39;&#39;&#39;The SetRestrictions property defined the SetRestrictions object class.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">SpeechPacket</span> <span class="o">=</span> <span class="s">&quot;SpeechPacket&quot;</span>
    <span class="sd">&#39;&#39;&#39;The SpeechPacket property defined the SpeechPacket object class.&#39;&#39;&#39;</span>

    <span class="n">SpeechRecognized</span> <span class="o">=</span> <span class="s">&quot;SpeechRecognized&quot;</span>
    <span class="sd">&#39;&#39;&#39;The SpeechRecognized property defined the SpeechRecognized object</span>
<span class="sd">    class.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">StartRequest</span> <span class="o">=</span> <span class="s">&quot;StartRequest&quot;</span>
    <span class="sd">&#39;&#39;&#39;The StartRequest property defined the StartRequest object class.&#39;&#39;&#39;</span>

    <span class="n">StartSpeechRequest</span> <span class="o">=</span> <span class="s">&quot;StartSpeechRequest&quot;</span>
    <span class="sd">&#39;&#39;&#39;The StartSpeechRequest property defined the StartSpeechRequest</span>
<span class="sd">    object class.</span>

<span class="sd">    &#39;&#39;&#39;</span>

</div>
<div class="viewcode-block" id="Keys"><a class="viewcode-back" href="../../_generated/pysiriproxy_constants.html#pysiriproxy.constants.Keys">[docs]</a><span class="k">class</span> <span class="nc">Keys</span><span class="p">:</span>
    <span class="sd">&#39;&#39;&#39;The Keys class defines various properties which contain strings which</span>
<span class="sd">    are keys to the dictionary objects sent between the iPhone and Apple&#39;s</span>
<span class="sd">    server.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">AceId</span> <span class="o">=</span> <span class="s">&quot;aceId&quot;</span>
    <span class="sd">&#39;&#39;&#39;The aceId key.&#39;&#39;&#39;</span>

    <span class="n">AssistantId</span> <span class="o">=</span> <span class="s">&#39;AssistantId&#39;</span>
    <span class="sd">&#39;&#39;&#39;The key for the AssistantId property of an object.&#39;&#39;&#39;</span>

    <span class="n">Birthday</span> <span class="o">=</span> <span class="s">&quot;birthday&quot;</span>
    <span class="sd">&#39;&#39;&#39;The birthday key for an object.&#39;&#39;&#39;</span>

    <span class="n">Class</span> <span class="o">=</span> <span class="s">&quot;class&quot;</span>
    <span class="sd">&#39;&#39;&#39;The class name for the object.&#39;&#39;&#39;</span>

    <span class="n">Data</span> <span class="o">=</span> <span class="s">&quot;data&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the data property of an object. &#39;&#39;&#39;</span>

    <span class="n">Date</span> <span class="o">=</span> <span class="s">&quot;date&quot;</span>
    <span class="sd">&#39;&#39;&#39;The date key for an object.&#39;&#39;&#39;</span>

    <span class="n">DateSent</span> <span class="o">=</span> <span class="s">&quot;dateSent&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the dateSent property of an object.&#39;&#39;&#39;</span>

    <span class="n">DisplayText</span> <span class="o">=</span> <span class="s">&quot;displayText&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the displayText property of an object.&#39;&#39;&#39;</span>

    <span class="n">DueDate</span> <span class="o">=</span> <span class="s">&quot;dueDate&quot;</span>
    <span class="sd">&#39;&#39;&#39;The due date key for an object.&#39;&#39;&#39;</span>

    <span class="n">FirstName</span> <span class="o">=</span> <span class="s">&quot;firstName&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the firstName property of an object.&#39;&#39;&#39;</span>

    <span class="n">FullName</span> <span class="o">=</span> <span class="s">&quot;fullName&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the fullName property of an object.&#39;&#39;&#39;</span>

    <span class="n">Group</span> <span class="o">=</span> <span class="s">&quot;group&quot;</span>
    <span class="sd">&#39;&#39;&#39;The group for the object.&#39;&#39;&#39;</span>

    <span class="n">Identifier</span> <span class="o">=</span> <span class="s">&quot;identifier&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the identifier property of an object.&#39;&#39;&#39;</span>

    <span class="n">Interpretations</span> <span class="o">=</span> <span class="s">&quot;interpretations&quot;</span>
    <span class="sd">&#39;&#39;&#39;The interpretations key for an object.&#39;&#39;&#39;</span>

    <span class="n">Label</span> <span class="o">=</span> <span class="s">&quot;label&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the label property of an object.&#39;&#39;&#39;</span>

    <span class="n">LastName</span> <span class="o">=</span> <span class="s">&quot;lastName&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the lastName property of an object.&#39;&#39;&#39;</span>

    <span class="n">MsgSender</span> <span class="o">=</span> <span class="s">&quot;msgSender&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the msgSender property of an object.&#39;&#39;&#39;</span>

    <span class="n">Number</span> <span class="o">=</span> <span class="s">&quot;number&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the number property of an object.&#39;&#39;&#39;</span>

    <span class="n">OrderedContext</span> <span class="o">=</span> <span class="s">&#39;orderedContext&#39;</span>
    <span class="sd">&#39;&#39;&#39;The key for the orderedContext property of an object.&#39;&#39;&#39;</span>

    <span class="n">Outgoing</span> <span class="o">=</span> <span class="s">&quot;outgoing&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the outgoing property of an object.&#39;&#39;&#39;</span>

    <span class="n">Phones</span> <span class="o">=</span> <span class="s">&quot;phones&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the phones property of an object.&#39;&#39;&#39;</span>

    <span class="n">Phrases</span> <span class="o">=</span> <span class="s">&quot;phrases&quot;</span>
    <span class="sd">&#39;&#39;&#39;The phrases key for an object.&#39;&#39;&#39;</span>

    <span class="n">Properties</span> <span class="o">=</span> <span class="s">&quot;properties&quot;</span>
    <span class="sd">&#39;&#39;&#39;The properties key for the object.&#39;&#39;&#39;</span>

    <span class="n">Recognition</span> <span class="o">=</span> <span class="s">&quot;recognition&quot;</span>
    <span class="sd">&#39;&#39;&#39;The recognition key for an object.&#39;&#39;&#39;</span>

    <span class="n">RefId</span> <span class="o">=</span> <span class="s">&quot;refId&quot;</span>
    <span class="sd">&#39;&#39;&#39;The refId for the object.&#39;&#39;&#39;</span>

    <span class="n">RemoveSpaceAfter</span> <span class="o">=</span> <span class="s">&quot;removeSpaceAfter&quot;</span>
    <span class="sd">&#39;&#39;&#39;The removeSpaceAfter key for an object.&#39;&#39;&#39;</span>

    <span class="n">RemoveSpaceBefore</span> <span class="o">=</span> <span class="s">&quot;removeSpaceBefore&quot;</span>
    <span class="sd">&#39;&#39;&#39;The removeSpaceBefore key for an object.&#39;&#39;&#39;</span>

    <span class="n">SelectionResponse</span> <span class="o">=</span> <span class="s">&quot;selectionResponse&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the selectionResponse property of an object.&#39;&#39;&#39;</span>

    <span class="n">SessionValidationData</span> <span class="o">=</span> <span class="s">&#39;SessionValidationData&#39;</span>
    <span class="sd">&#39;&#39;&#39;The key for the SessionValidationData property of an object.&#39;&#39;&#39;</span>

    <span class="n">SpeakableSelectionResponse</span> <span class="o">=</span> <span class="s">&quot;speakableSelectionResponse&quot;</span>
    <span class="sd">&#39;&#39;&#39;The key for the speakableSelectionResponse property of an object.&#39;&#39;&#39;</span>

    <span class="n">SpeakableText</span> <span class="o">=</span> <span class="s">&quot;speakableText&quot;</span>
    <span class="sd">&#39;&#39;&#39;The speakable text key for an object.&#39;&#39;&#39;</span>

    <span class="n">SpeechId</span> <span class="o">=</span> <span class="s">&#39;SpeechId&#39;</span>
    <span class="sd">&#39;&#39;&#39;The key for the SpeechId property of an object.&#39;&#39;&#39;</span>

    <span class="n">Street</span> <span class="o">=</span> <span class="s">&quot;street&quot;</span>
    <span class="sd">&#39;&#39;&#39;The street value.&#39;&#39;&#39;</span>

    <span class="n">Text</span> <span class="o">=</span> <span class="s">&quot;text&quot;</span>
    <span class="sd">&#39;&#39;&#39;The text key for an object.&#39;&#39;&#39;</span>

    <span class="n">Title</span> <span class="o">=</span> <span class="s">&quot;title&quot;</span>
    <span class="sd">&#39;&#39;&#39;The title key for an object.&#39;&#39;&#39;</span>

    <span class="n">Tokens</span> <span class="o">=</span> <span class="s">&quot;tokens&quot;</span>
    <span class="sd">&#39;&#39;&#39;The tokens key for an object.&#39;&#39;&#39;</span>

    <span class="n">Utterance</span> <span class="o">=</span> <span class="s">&quot;utterance&quot;</span>
    <span class="sd">&#39;&#39;&#39;The utterance key for an object.&#39;&#39;&#39;</span>

    <span class="n">Version</span> <span class="o">=</span> <span class="s">&quot;v&quot;</span>
    <span class="sd">&#39;&#39;&#39;The version key for an object.&#39;&#39;&#39;</span>

</div>
<div class="viewcode-block" id="DirectionTypes"><a class="viewcode-back" href="../../_generated/pysiriproxy_constants.html#pysiriproxy.constants.DirectionTypes">[docs]</a><span class="k">class</span> <span class="nc">DirectionTypes</span><span class="p">:</span>
    <span class="sd">&#39;&#39;&#39;The DirectionTypes class encapsulates the various modes of</span>
<span class="sd">    transportation which can be used to generate directions.</span>

<span class="sd">    &#39;&#39;&#39;</span>
    <span class="n">Driving</span> <span class="o">=</span> <span class="s">&quot;ByCar&quot;</span>
    <span class="sd">&#39;&#39;&#39;Directions for driving.&#39;&#39;&#39;</span>

    <span class="n">PublicTransit</span> <span class="o">=</span> <span class="s">&quot;ByPublicTransit&quot;</span>
    <span class="sd">&#39;&#39;&#39;Directions for public transportation.&#39;&#39;&#39;</span>

    <span class="n">Walking</span> <span class="o">=</span> <span class="s">&quot;Walking&quot;</span>
    <span class="sd">&#39;&#39;&#39;Directions for walking.&#39;&#39;&#39;</span>

</div>
<div class="viewcode-block" id="HeaderKeys"><a class="viewcode-back" href="../../_generated/pysiriproxy_constants.html#pysiriproxy.constants.HeaderKeys">[docs]</a><span class="k">class</span> <span class="nc">HeaderKeys</span><span class="p">:</span>
    <span class="sd">&#39;&#39;&#39;The HeaderKeys class contains definitions of various tags</span>
<span class="sd">    that are sent in headers.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">ContentLength</span> <span class="o">=</span> <span class="s">&quot;Content-Length&quot;</span>
    <span class="sd">&#39;&#39;&#39;The content length header tag.&#39;&#39;&#39;</span>

    <span class="n">Host</span> <span class="o">=</span> <span class="s">&quot;Host&quot;</span>
    <span class="sd">&#39;&#39;&#39;The Host header tag.&#39;&#39;&#39;</span>

    <span class="n">UserAgent</span> <span class="o">=</span> <span class="s">&quot;User-Agent&quot;</span>
    <span class="sd">&#39;&#39;&#39;The user agent header tag.&#39;&#39;&#39;</span>

    <span class="n">XAceHost</span> <span class="o">=</span> <span class="s">&quot;X-Ace-Host&quot;</span>
    <span class="sd">&#39;&#39;&#39;The x ace host header tag.&#39;&#39;&#39;</span></div>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../index.html">pysiriproxy v0.0.7 documentation</a> &raquo;</li>
          <li><a href="../index.html" >Module code</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>